﻿#region License

// Copyright (c) 2009, Bill O'Neill (william.w.oneill@gmail.com)
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without 
// modification, are permitted provided that the following conditions 
// are met:
// 
// 1. Redistributions of source code must retain the above copyright 
// notice, this list of conditions and the following disclaimer.
// 
// 2. Redistributions in binary form must reproduce the above copyright 
// notice, this list of conditions and the following disclaimer in the 
// documentation and/or other materials provided with the distribution.
// 
// 3. Neither the name of Focal Point Technology Solutions, LLC nor 
// the names of its contributors may be used to endorse or promote 
// products derived from this software without specific prior written 
// permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
// CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
// DAMAGE.

#endregion

using System;

namespace X10d.Interface
{
	/// <summary>
	/// Represents a command that will be sent to an X10 device
	/// </summary>
	public class DeviceCommand
	{
		private int? mLightLevel;

		/// <summary>
		/// Gets and sets the X10 house code
		/// </summary>
		public HouseCodeType HouseCode { get; set; }

		/// <summary>
		/// Get and sets the device number
		/// </summary>
		public DeviceCodeType Device { get; set; }

		/// <summary>
		/// Gets and sets the X10 function
		/// </summary>
		public FunctionCodeType Function { get; set; }

		/// <summary>
		/// Gets the maximum dimmer value
		/// </summary>
		public static readonly int MaxDimValue = 100;

		/// <summary>
		/// Gets the minimum dimmer value
		/// </summary>
		public static readonly int MinDimValue = 0;

		/// <summary>
		/// Gets and sets the light level.
		/// </summary>
		/// <remarks>
		/// Only applicable to dimmer commands and if the physical device supports dimming.
		/// <para>
		/// Valid values are between 0 and 100.
		/// </para>
		/// </remarks>
		public int? LightLevel
		{
			get { return mLightLevel; }
			set
			{
				if (value > MaxDimValue || value < MinDimValue)
				{
					throw new ArgumentException(string.Format(
					                            	"Invalid light level. Value must be between {0} and {1}.",
					                            	MinDimValue, MaxDimValue));
				}

				mLightLevel = value;
			}
		}
	}
}